Skip to content

docs: update instructions#2297

Merged
benesjan merged 26 commits into
masterfrom
janb/sandbox-update-docs
Sep 22, 2023
Merged

docs: update instructions#2297
benesjan merged 26 commits into
masterfrom
janb/sandbox-update-docs

Conversation

@benesjan

Copy link
Copy Markdown
Contributor

Fixes #1827

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

@benesjan benesjan marked this pull request as draft September 14, 2023 13:11
@benesjan benesjan force-pushed the janb/sandbox-update-docs branch from 497a64e to 4eebdf9 Compare September 14, 2023 13:31
@benesjan benesjan marked this pull request as ready for review September 14, 2023 13:34
Comment thread docs/docs/dev_docs/getting_started/sandbox.md Outdated
Comment thread docs/docs/dev_docs/getting_started/cli.md Outdated
Comment thread docs/docs/dev_docs/getting_started/cli.md Outdated
Comment thread docs/docs/dev_docs/getting_started/sandbox.md Outdated
@benesjan benesjan force-pushed the janb/sandbox-update-docs branch from c92e4d1 to 0a86c68 Compare September 15, 2023 09:54
@benesjan benesjan enabled auto-merge (squash) September 15, 2023 10:05
@iAmMichaelConnor

Copy link
Copy Markdown
Contributor

I just remembered something (which would make the "definition of done" for this issue a bit more work) - we should probably also include instructions for how to update to the correct versions of nargo and aztec-nr, and how the user should update their own project (e.g. updating their own project's Nargo file) to adjust to the new nargo and aztec-nr versions. We should also provide a link to our release changelogs, so that a user can read about changes that they might need to make to their contract, to make it work with the new nargo/aztec-nr.

There's a relevant discussion here, where @spalladino provides some good insight:
https://aztecprotocol.slack.com/archives/C03P17YHVK8/p1694597144800569?thread_ts=1694542462.519609&cid=C03P17YHVK8

It might even be worth creating a new file dev-docs/getting-started/updating.md, because there's so much to explain. All of the explanations you've already done could be moved to this new file instead, perhaps?

@iAmMichaelConnor

Copy link
Copy Markdown
Contributor

Disabled auto-merge, in light of my comment above (sorry :) )

@benesjan

Copy link
Copy Markdown
Contributor Author

@iAmMichaelConnor makes sense. Will do the changes 👍

@benesjan benesjan marked this pull request as draft September 15, 2023 10:14
@benesjan benesjan changed the title docs: sandbox update instructions docs: update instructions Sep 15, 2023
@benesjan benesjan force-pushed the janb/sandbox-update-docs branch from 62c99ce to 7faa014 Compare September 18, 2023 10:51
@benesjan benesjan marked this pull request as ready for review September 19, 2023 09:33
Comment on lines +34 to +38
Sandbox Version: 0.7.7
Compatible Nargo Version: 0.11.1-aztec.0
Chain Id: 31337
Protocol Version: 1
Rollup Address: 0x0dcd1bf9a1b36ce34237eeafef220932846bcd82

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we assert that the returned text from the command matches this? It's a bit annoying since we need to load the versions from the release-please-manifest and the noir-version jsons. Or we can just parse it manually, and use an expect.anything() for those values.

Comment thread docs/docs/dev_docs/getting_started/updating.md
Comment thread docs/docs/dev_docs/getting_started/updating.md Outdated
Comment thread docs/docs/dev_docs/getting_started/updating.md Outdated
Comment thread docs/docs/dev_docs/getting_started/updating.md
Comment thread docs/docs/dev_docs/getting_started/updating.md Outdated
Comment thread docs/docs/dev_docs/getting_started/updating.md Outdated
Comment thread docs/docs/dev_docs/getting_started/updating.md
benesjan and others added 2 commits September 21, 2023 08:50
Co-authored-by: Santiago Palladino <santiago@aztecprotocol.com>
@benesjan benesjan dismissed iAmMichaelConnor’s stale review September 21, 2023 07:00

Mike is on vacations and for this reason his requests are no longer respected.

@benesjan benesjan enabled auto-merge (squash) September 22, 2023 07:15
@benesjan benesjan merged commit ab612df into master Sep 22, 2023
@benesjan benesjan deleted the janb/sandbox-update-docs branch September 22, 2023 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

Document update instructions for Sandbox

3 participants